Interface HTTPClient

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
HTTPBackgroundClient
All Known Implementing Classes:
HTTPBackgroundClientImpl, HTTPClientImpl

public interface HTTPClient extends Process
Information provided by the PKI file:

    \class HttpClient
    
    \brief HttpClient handles and manipulates the HTTP client on devices.
    
    \example network().getDevice("PC0").getProcess("HttpClient")
    
Author:
Auto-generated
  • Method Details

    • go

      boolean go(String url)
      Information provided by the PKI file:
      
          \brief Creates an HTTP request to the specified URL.
          
          \param url, the URL of the destination.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      url - Takes in a parameter of url
      Returns:
      boolean Returns a boolean
    • http_get

      boolean http_get(String url, String header)
      Parameters:
      url - Takes in a parameter of url
      header - Takes in a parameter of header
      Returns:
      boolean Returns a boolean
    • http_post

      boolean http_post(String url, String body, String header)
      Parameters:
      url - Takes in a parameter of url
      body - Takes in a parameter of body
      header - Takes in a parameter of header
      Returns:
      boolean Returns a boolean
    • http_delete

      boolean http_delete(String url, String body, String header)
      Parameters:
      url - Takes in a parameter of url
      body - Takes in a parameter of body
      header - Takes in a parameter of header
      Returns:
      boolean Returns a boolean
    • http_put

      boolean http_put(String url, String body, String header)
      Parameters:
      url - Takes in a parameter of url
      body - Takes in a parameter of body
      header - Takes in a parameter of header
      Returns:
      boolean Returns a boolean
    • cancel

      boolean cancel()
      Information provided by the PKI file:
      
          \brief cancel HTTP request and close tcp connection.
          
          \return bool, true if successful, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getLastPageContent

      String getLastPageContent()
      Information provided by the PKI file:
      
          \brief Returns the last page content retrived from an HTTP response.
          
          \return string, the last page content retrived from an HTTP response.
          
              
      Returns:
      String Returns a String
    • setHttps

      void setHttps(boolean status)
      Information provided by the PKI file:
      
          \brief Sets the HttpClient process to use HTTPS if status is true, otherwise HTTP.
          
          \param status, true if HTTPS, false if HTTP.
          
              
      Parameters:
      status - Takes in a parameter of status
    • isHttps

      boolean isHttps()
      Information provided by the PKI file:
      
          \brief Returns true if the HttpClient process is set to HTTPS, false if HTTP.
          
          \return bool, true if the HttpClient process is set to HTTPS, false if HTTP.
          
              
      Returns:
      boolean Returns a boolean